<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.pop3;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.Reader;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.security.MessageDigest;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.security.NoSuchAlgorithmException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.ListIterator;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.StringTokenizer;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.commons.net.io.DotTerminatedMessageReader;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/***<a name="line.29"></a>
<span class="sourceLineNo">030</span> * The POP3Client class implements the client side of the Internet POP3<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Protocol defined in RFC 1939.  All commands are supported, including<a name="line.31"></a>
<span class="sourceLineNo">032</span> * the APOP command which requires MD5 encryption.  See RFC 1939 for<a name="line.32"></a>
<span class="sourceLineNo">033</span> * more details on the POP3 protocol.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Rather than list it separately for each method, we mention here that<a name="line.35"></a>
<span class="sourceLineNo">036</span> * every method communicating with the server and throwing an IOException<a name="line.36"></a>
<span class="sourceLineNo">037</span> * can also throw a<a name="line.37"></a>
<span class="sourceLineNo">038</span> * {@link org.apache.commons.net.MalformedServerReplyException}<a name="line.38"></a>
<span class="sourceLineNo">039</span> * , which is a subclass<a name="line.39"></a>
<span class="sourceLineNo">040</span> * of IOException.  A MalformedServerReplyException will be thrown when<a name="line.40"></a>
<span class="sourceLineNo">041</span> * the reply received from the server deviates enough from the protocol<a name="line.41"></a>
<span class="sourceLineNo">042</span> * specification that it cannot be interpreted in a useful manner despite<a name="line.42"></a>
<span class="sourceLineNo">043</span> * attempts to be as lenient as possible.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @see POP3MessageInfo<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @see org.apache.commons.net.io.DotTerminatedMessageReader<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @see org.apache.commons.net.MalformedServerReplyException<a name="line.48"></a>
<span class="sourceLineNo">049</span> ***/<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>public class POP3Client extends POP3<a name="line.51"></a>
<span class="sourceLineNo">052</span>{<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    private static POP3MessageInfo __parseStatus(String line)<a name="line.54"></a>
<span class="sourceLineNo">055</span>    {<a name="line.55"></a>
<span class="sourceLineNo">056</span>        int num, size;<a name="line.56"></a>
<span class="sourceLineNo">057</span>        StringTokenizer tokenizer;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>        tokenizer = new StringTokenizer(line);<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>        if (!tokenizer.hasMoreElements()) {<a name="line.61"></a>
<span class="sourceLineNo">062</span>            return null;<a name="line.62"></a>
<span class="sourceLineNo">063</span>        }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>        num = size = 0;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>        try<a name="line.67"></a>
<span class="sourceLineNo">068</span>        {<a name="line.68"></a>
<span class="sourceLineNo">069</span>            num = Integer.parseInt(tokenizer.nextToken());<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>            if (!tokenizer.hasMoreElements()) {<a name="line.71"></a>
<span class="sourceLineNo">072</span>                return null;<a name="line.72"></a>
<span class="sourceLineNo">073</span>            }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>            size = Integer.parseInt(tokenizer.nextToken());<a name="line.75"></a>
<span class="sourceLineNo">076</span>        }<a name="line.76"></a>
<span class="sourceLineNo">077</span>        catch (NumberFormatException e)<a name="line.77"></a>
<span class="sourceLineNo">078</span>        {<a name="line.78"></a>
<span class="sourceLineNo">079</span>            return null;<a name="line.79"></a>
<span class="sourceLineNo">080</span>        }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>        return new POP3MessageInfo(num, size);<a name="line.82"></a>
<span class="sourceLineNo">083</span>    }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>    private static POP3MessageInfo __parseUID(String line)<a name="line.85"></a>
<span class="sourceLineNo">086</span>    {<a name="line.86"></a>
<span class="sourceLineNo">087</span>        int num;<a name="line.87"></a>
<span class="sourceLineNo">088</span>        StringTokenizer tokenizer;<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>        tokenizer = new StringTokenizer(line);<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>        if (!tokenizer.hasMoreElements()) {<a name="line.92"></a>
<span class="sourceLineNo">093</span>            return null;<a name="line.93"></a>
<span class="sourceLineNo">094</span>        }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>        num = 0;<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>        try<a name="line.98"></a>
<span class="sourceLineNo">099</span>        {<a name="line.99"></a>
<span class="sourceLineNo">100</span>            num = Integer.parseInt(tokenizer.nextToken());<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>            if (!tokenizer.hasMoreElements()) {<a name="line.102"></a>
<span class="sourceLineNo">103</span>                return null;<a name="line.103"></a>
<span class="sourceLineNo">104</span>            }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>            line = tokenizer.nextToken();<a name="line.106"></a>
<span class="sourceLineNo">107</span>        }<a name="line.107"></a>
<span class="sourceLineNo">108</span>        catch (NumberFormatException e)<a name="line.108"></a>
<span class="sourceLineNo">109</span>        {<a name="line.109"></a>
<span class="sourceLineNo">110</span>            return null;<a name="line.110"></a>
<span class="sourceLineNo">111</span>        }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>        return new POP3MessageInfo(num, line);<a name="line.113"></a>
<span class="sourceLineNo">114</span>    }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>    /***<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * Send a CAPA command to the POP3 server.<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * @return True if the command was successful, false if not.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.119"></a>
<span class="sourceLineNo">120</span>     *        sending the CAPA command.<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * @since 3.1 (was previously in ExtendedPOP3Client)<a name="line.121"></a>
<span class="sourceLineNo">122</span>     ***/<a name="line.122"></a>
<span class="sourceLineNo">123</span>    public boolean capa() throws IOException<a name="line.123"></a>
<span class="sourceLineNo">124</span>    {<a name="line.124"></a>
<span class="sourceLineNo">125</span>        if (sendCommand(POP3Command.CAPA) == POP3Reply.OK) {<a name="line.125"></a>
<span class="sourceLineNo">126</span>            getAdditionalReply();<a name="line.126"></a>
<span class="sourceLineNo">127</span>            return true;<a name="line.127"></a>
<span class="sourceLineNo">128</span>        }<a name="line.128"></a>
<span class="sourceLineNo">129</span>        return false;<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    /***<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * Login to the POP3 server with the given username and password.  You<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * must first connect to the server with<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * {@link org.apache.commons.net.SocketClient#connect  connect }<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * before attempting to login.  A login attempt is only valid if<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * the client is in the<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * {@link org.apache.commons.net.pop3.POP3#AUTHORIZATION_STATE AUTHORIZATION_STATE }<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * .  After logging in, the client enters the<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * .<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * &lt;p&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @param username  The account name being logged in to.<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * @param password  The plain text password of the account.<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * @return True if the login attempt was successful, false if not.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.147"></a>
<span class="sourceLineNo">148</span>     *            logging in.<a name="line.148"></a>
<span class="sourceLineNo">149</span>     ***/<a name="line.149"></a>
<span class="sourceLineNo">150</span>    public boolean login(String username, String password) throws IOException<a name="line.150"></a>
<span class="sourceLineNo">151</span>    {<a name="line.151"></a>
<span class="sourceLineNo">152</span>        if (getState() != AUTHORIZATION_STATE) {<a name="line.152"></a>
<span class="sourceLineNo">153</span>            return false;<a name="line.153"></a>
<span class="sourceLineNo">154</span>        }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span>        if (sendCommand(POP3Command.USER, username) != POP3Reply.OK) {<a name="line.156"></a>
<span class="sourceLineNo">157</span>            return false;<a name="line.157"></a>
<span class="sourceLineNo">158</span>        }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span>        if (sendCommand(POP3Command.PASS, password) != POP3Reply.OK) {<a name="line.160"></a>
<span class="sourceLineNo">161</span>            return false;<a name="line.161"></a>
<span class="sourceLineNo">162</span>        }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>        setState(TRANSACTION_STATE);<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span>        return true;<a name="line.166"></a>
<span class="sourceLineNo">167</span>    }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span>    /***<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * Login to the POP3 server with the given username and authentication<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * information.  Use this method when connecting to a server requiring<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * authentication using the APOP command.  Because the timestamp<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * produced in the greeting banner varies from server to server, it is<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * not possible to consistently extract the information.  Therefore,<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * after connecting to the server, you must call<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * {@link org.apache.commons.net.pop3.POP3#getReplyString getReplyString }<a name="line.177"></a>
<span class="sourceLineNo">178</span>     *  and parse out the timestamp information yourself.<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * &lt;p&gt;<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * You must first connect to the server with<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * {@link org.apache.commons.net.SocketClient#connect  connect }<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * before attempting to login.  A login attempt is only valid if<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * the client is in the<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * {@link org.apache.commons.net.pop3.POP3#AUTHORIZATION_STATE AUTHORIZATION_STATE }<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * .  After logging in, the client enters the<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * .  After connecting, you must parse out the<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * server specific information to use as a timestamp, and pass that<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * information to this method.  The secret is a shared secret known<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * to you and the server.  See RFC 1939 for more details regarding<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * the APOP command.<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * &lt;p&gt;<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * @param username  The account name being logged in to.<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * @param timestamp  The timestamp string to combine with the secret.<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * @param secret  The shared secret which produces the MD5 digest when<a name="line.195"></a>
<span class="sourceLineNo">196</span>     *        combined with the timestamp.<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * @return True if the login attempt was successful, false if not.<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.198"></a>
<span class="sourceLineNo">199</span>     *            logging in.<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * @exception NoSuchAlgorithmException If the MD5 encryption algorithm<a name="line.200"></a>
<span class="sourceLineNo">201</span>     *      cannot be instantiated by the Java runtime system.<a name="line.201"></a>
<span class="sourceLineNo">202</span>     ***/<a name="line.202"></a>
<span class="sourceLineNo">203</span>    public boolean login(String username, String timestamp, String secret)<a name="line.203"></a>
<span class="sourceLineNo">204</span>    throws IOException, NoSuchAlgorithmException<a name="line.204"></a>
<span class="sourceLineNo">205</span>    {<a name="line.205"></a>
<span class="sourceLineNo">206</span>        int i;<a name="line.206"></a>
<span class="sourceLineNo">207</span>        byte[] digest;<a name="line.207"></a>
<span class="sourceLineNo">208</span>        StringBuilder buffer, digestBuffer;<a name="line.208"></a>
<span class="sourceLineNo">209</span>        MessageDigest md5;<a name="line.209"></a>
<span class="sourceLineNo">210</span><a name="line.210"></a>
<span class="sourceLineNo">211</span>        if (getState() != AUTHORIZATION_STATE) {<a name="line.211"></a>
<span class="sourceLineNo">212</span>            return false;<a name="line.212"></a>
<span class="sourceLineNo">213</span>        }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span>        md5 = MessageDigest.getInstance("MD5");<a name="line.215"></a>
<span class="sourceLineNo">216</span>        timestamp += secret;<a name="line.216"></a>
<span class="sourceLineNo">217</span>        digest = md5.digest(timestamp.getBytes(getCharsetName())); // Java 1.6 can use getCharset()<a name="line.217"></a>
<span class="sourceLineNo">218</span>        digestBuffer = new StringBuilder(128);<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span>        for (i = 0; i &lt; digest.length; i++) {<a name="line.220"></a>
<span class="sourceLineNo">221</span>            int digit = digest[i] &amp; 0xff;<a name="line.221"></a>
<span class="sourceLineNo">222</span>            if (digit &lt;= 15) { // Add leading zero if necessary (NET-351)<a name="line.222"></a>
<span class="sourceLineNo">223</span>                digestBuffer.append("0");<a name="line.223"></a>
<span class="sourceLineNo">224</span>            }<a name="line.224"></a>
<span class="sourceLineNo">225</span>            digestBuffer.append(Integer.toHexString(digit));<a name="line.225"></a>
<span class="sourceLineNo">226</span>        }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span>        buffer = new StringBuilder(256);<a name="line.228"></a>
<span class="sourceLineNo">229</span>        buffer.append(username);<a name="line.229"></a>
<span class="sourceLineNo">230</span>        buffer.append(' ');<a name="line.230"></a>
<span class="sourceLineNo">231</span>        buffer.append(digestBuffer.toString());<a name="line.231"></a>
<span class="sourceLineNo">232</span><a name="line.232"></a>
<span class="sourceLineNo">233</span>        if (sendCommand(POP3Command.APOP, buffer.toString()) != POP3Reply.OK) {<a name="line.233"></a>
<span class="sourceLineNo">234</span>            return false;<a name="line.234"></a>
<span class="sourceLineNo">235</span>        }<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span>        setState(TRANSACTION_STATE);<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span>        return true;<a name="line.239"></a>
<span class="sourceLineNo">240</span>    }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span>    /***<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * Logout of the POP3 server.  To fully disconnect from the server<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * you must call<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * {@link org.apache.commons.net.pop3.POP3#disconnect  disconnect }.<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * A logout attempt is valid in any state.  If<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * the client is in the<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.249"></a>
<span class="sourceLineNo">250</span>     * , it enters the<a name="line.250"></a>
<span class="sourceLineNo">251</span>     * {@link org.apache.commons.net.pop3.POP3#UPDATE_STATE UPDATE_STATE }<a name="line.251"></a>
<span class="sourceLineNo">252</span>     *  on a successful logout.<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * &lt;p&gt;<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * @return True if the logout attempt was successful, false if not.<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * @exception IOException If a network I/O error occurs in the process<a name="line.255"></a>
<span class="sourceLineNo">256</span>     *           of logging out.<a name="line.256"></a>
<span class="sourceLineNo">257</span>     ***/<a name="line.257"></a>
<span class="sourceLineNo">258</span>    public boolean logout() throws IOException<a name="line.258"></a>
<span class="sourceLineNo">259</span>    {<a name="line.259"></a>
<span class="sourceLineNo">260</span>        if (getState() == TRANSACTION_STATE) {<a name="line.260"></a>
<span class="sourceLineNo">261</span>            setState(UPDATE_STATE);<a name="line.261"></a>
<span class="sourceLineNo">262</span>        }<a name="line.262"></a>
<span class="sourceLineNo">263</span>        sendCommand(POP3Command.QUIT);<a name="line.263"></a>
<span class="sourceLineNo">264</span>        return (_replyCode == POP3Reply.OK);<a name="line.264"></a>
<span class="sourceLineNo">265</span>    }<a name="line.265"></a>
<span class="sourceLineNo">266</span><a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span>    /***<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * Send a NOOP command to the POP3 server.  This is useful for keeping<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * a connection alive since most POP3 servers will timeout after 10<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * minutes of inactivity.  A noop attempt will only succeed if<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * the client is in the<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * .<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * &lt;p&gt;<a name="line.275"></a>
<span class="sourceLineNo">276</span>     * @return True if the noop attempt was successful, false if not.<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.277"></a>
<span class="sourceLineNo">278</span>     *        sending the NOOP command.<a name="line.278"></a>
<span class="sourceLineNo">279</span>     ***/<a name="line.279"></a>
<span class="sourceLineNo">280</span>    public boolean noop() throws IOException<a name="line.280"></a>
<span class="sourceLineNo">281</span>    {<a name="line.281"></a>
<span class="sourceLineNo">282</span>        if (getState() == TRANSACTION_STATE) {<a name="line.282"></a>
<span class="sourceLineNo">283</span>            return (sendCommand(POP3Command.NOOP) == POP3Reply.OK);<a name="line.283"></a>
<span class="sourceLineNo">284</span>        }<a name="line.284"></a>
<span class="sourceLineNo">285</span>        return false;<a name="line.285"></a>
<span class="sourceLineNo">286</span>    }<a name="line.286"></a>
<span class="sourceLineNo">287</span><a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span>    /***<a name="line.289"></a>
<span class="sourceLineNo">290</span>     * Delete a message from the POP3 server.  The message is only marked<a name="line.290"></a>
<span class="sourceLineNo">291</span>     * for deletion by the server.  If you decide to unmark the message, you<a name="line.291"></a>
<span class="sourceLineNo">292</span>     * must issuse a {@link #reset  reset } command.  Messages marked<a name="line.292"></a>
<span class="sourceLineNo">293</span>     * for deletion are only deleted by the server on<a name="line.293"></a>
<span class="sourceLineNo">294</span>     * {@link #logout  logout }.<a name="line.294"></a>
<span class="sourceLineNo">295</span>     * A delete attempt can only succeed if the client is in the<a name="line.295"></a>
<span class="sourceLineNo">296</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.296"></a>
<span class="sourceLineNo">297</span>     * .<a name="line.297"></a>
<span class="sourceLineNo">298</span>     * &lt;p&gt;<a name="line.298"></a>
<span class="sourceLineNo">299</span>     * @param messageId  The message number to delete.<a name="line.299"></a>
<span class="sourceLineNo">300</span>     * @return True if the deletion attempt was successful, false if not.<a name="line.300"></a>
<span class="sourceLineNo">301</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.301"></a>
<span class="sourceLineNo">302</span>     *           sending the delete command.<a name="line.302"></a>
<span class="sourceLineNo">303</span>     ***/<a name="line.303"></a>
<span class="sourceLineNo">304</span>    public boolean deleteMessage(int messageId) throws IOException<a name="line.304"></a>
<span class="sourceLineNo">305</span>    {<a name="line.305"></a>
<span class="sourceLineNo">306</span>        if (getState() == TRANSACTION_STATE) {<a name="line.306"></a>
<span class="sourceLineNo">307</span>            return (sendCommand(POP3Command.DELE, Integer.toString(messageId))<a name="line.307"></a>
<span class="sourceLineNo">308</span>                    == POP3Reply.OK);<a name="line.308"></a>
<span class="sourceLineNo">309</span>        }<a name="line.309"></a>
<span class="sourceLineNo">310</span>        return false;<a name="line.310"></a>
<span class="sourceLineNo">311</span>    }<a name="line.311"></a>
<span class="sourceLineNo">312</span><a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span>    /***<a name="line.314"></a>
<span class="sourceLineNo">315</span>     * Reset the POP3 session.  This is useful for undoing any message<a name="line.315"></a>
<span class="sourceLineNo">316</span>     * deletions that may have been performed.  A reset attempt can only<a name="line.316"></a>
<span class="sourceLineNo">317</span>     * succeed if the client is in the<a name="line.317"></a>
<span class="sourceLineNo">318</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.318"></a>
<span class="sourceLineNo">319</span>     * .<a name="line.319"></a>
<span class="sourceLineNo">320</span>     * &lt;p&gt;<a name="line.320"></a>
<span class="sourceLineNo">321</span>     * @return True if the reset attempt was successful, false if not.<a name="line.321"></a>
<span class="sourceLineNo">322</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.322"></a>
<span class="sourceLineNo">323</span>     *      sending the reset command.<a name="line.323"></a>
<span class="sourceLineNo">324</span>     ***/<a name="line.324"></a>
<span class="sourceLineNo">325</span>    public boolean reset() throws IOException<a name="line.325"></a>
<span class="sourceLineNo">326</span>    {<a name="line.326"></a>
<span class="sourceLineNo">327</span>        if (getState() == TRANSACTION_STATE) {<a name="line.327"></a>
<span class="sourceLineNo">328</span>            return (sendCommand(POP3Command.RSET) == POP3Reply.OK);<a name="line.328"></a>
<span class="sourceLineNo">329</span>        }<a name="line.329"></a>
<span class="sourceLineNo">330</span>        return false;<a name="line.330"></a>
<span class="sourceLineNo">331</span>    }<a name="line.331"></a>
<span class="sourceLineNo">332</span><a name="line.332"></a>
<span class="sourceLineNo">333</span>    /***<a name="line.333"></a>
<span class="sourceLineNo">334</span>     * Get the mailbox status.  A status attempt can only<a name="line.334"></a>
<span class="sourceLineNo">335</span>     * succeed if the client is in the<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.336"></a>
<span class="sourceLineNo">337</span>     * .  Returns a POP3MessageInfo instance<a name="line.337"></a>
<span class="sourceLineNo">338</span>     * containing the number of messages in the mailbox and the total<a name="line.338"></a>
<span class="sourceLineNo">339</span>     * size of the messages in bytes.  Returns null if the status the<a name="line.339"></a>
<span class="sourceLineNo">340</span>     * attempt fails.<a name="line.340"></a>
<span class="sourceLineNo">341</span>     * &lt;p&gt;<a name="line.341"></a>
<span class="sourceLineNo">342</span>     * @return A POP3MessageInfo instance containing the number of<a name="line.342"></a>
<span class="sourceLineNo">343</span>     *         messages in the mailbox and the total size of the messages<a name="line.343"></a>
<span class="sourceLineNo">344</span>     *         in bytes.  Returns null if the status the attempt fails.<a name="line.344"></a>
<span class="sourceLineNo">345</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.345"></a>
<span class="sourceLineNo">346</span>     *       sending the status command.<a name="line.346"></a>
<span class="sourceLineNo">347</span>     ***/<a name="line.347"></a>
<span class="sourceLineNo">348</span>    public POP3MessageInfo status() throws IOException<a name="line.348"></a>
<span class="sourceLineNo">349</span>    {<a name="line.349"></a>
<span class="sourceLineNo">350</span>        if (getState() != TRANSACTION_STATE) {<a name="line.350"></a>
<span class="sourceLineNo">351</span>            return null;<a name="line.351"></a>
<span class="sourceLineNo">352</span>        }<a name="line.352"></a>
<span class="sourceLineNo">353</span>        if (sendCommand(POP3Command.STAT) != POP3Reply.OK) {<a name="line.353"></a>
<span class="sourceLineNo">354</span>            return null;<a name="line.354"></a>
<span class="sourceLineNo">355</span>        }<a name="line.355"></a>
<span class="sourceLineNo">356</span>        return __parseStatus(_lastReplyLine.substring(3));<a name="line.356"></a>
<span class="sourceLineNo">357</span>    }<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span><a name="line.359"></a>
<span class="sourceLineNo">360</span>    /***<a name="line.360"></a>
<span class="sourceLineNo">361</span>     * List an individual message.  A list attempt can only<a name="line.361"></a>
<span class="sourceLineNo">362</span>     * succeed if the client is in the<a name="line.362"></a>
<span class="sourceLineNo">363</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.363"></a>
<span class="sourceLineNo">364</span>     * .  Returns a POP3MessageInfo instance<a name="line.364"></a>
<span class="sourceLineNo">365</span>     * containing the number of the listed message and the<a name="line.365"></a>
<span class="sourceLineNo">366</span>     * size of the message in bytes.  Returns null if the list<a name="line.366"></a>
<span class="sourceLineNo">367</span>     * attempt fails (e.g., if the specified message number does<a name="line.367"></a>
<span class="sourceLineNo">368</span>     * not exist).<a name="line.368"></a>
<span class="sourceLineNo">369</span>     * &lt;p&gt;<a name="line.369"></a>
<span class="sourceLineNo">370</span>     * @param messageId  The number of the message list.<a name="line.370"></a>
<span class="sourceLineNo">371</span>     * @return A POP3MessageInfo instance containing the number of the<a name="line.371"></a>
<span class="sourceLineNo">372</span>     *         listed message and the size of the message in bytes.  Returns<a name="line.372"></a>
<span class="sourceLineNo">373</span>     *         null if the list attempt fails.<a name="line.373"></a>
<span class="sourceLineNo">374</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.374"></a>
<span class="sourceLineNo">375</span>     *         sending the list command.<a name="line.375"></a>
<span class="sourceLineNo">376</span>     ***/<a name="line.376"></a>
<span class="sourceLineNo">377</span>    public POP3MessageInfo listMessage(int messageId) throws IOException<a name="line.377"></a>
<span class="sourceLineNo">378</span>    {<a name="line.378"></a>
<span class="sourceLineNo">379</span>        if (getState() != TRANSACTION_STATE) {<a name="line.379"></a>
<span class="sourceLineNo">380</span>            return null;<a name="line.380"></a>
<span class="sourceLineNo">381</span>        }<a name="line.381"></a>
<span class="sourceLineNo">382</span>        if (sendCommand(POP3Command.LIST, Integer.toString(messageId))<a name="line.382"></a>
<span class="sourceLineNo">383</span>                != POP3Reply.OK) {<a name="line.383"></a>
<span class="sourceLineNo">384</span>            return null;<a name="line.384"></a>
<span class="sourceLineNo">385</span>        }<a name="line.385"></a>
<span class="sourceLineNo">386</span>        return __parseStatus(_lastReplyLine.substring(3));<a name="line.386"></a>
<span class="sourceLineNo">387</span>    }<a name="line.387"></a>
<span class="sourceLineNo">388</span><a name="line.388"></a>
<span class="sourceLineNo">389</span><a name="line.389"></a>
<span class="sourceLineNo">390</span>    /***<a name="line.390"></a>
<span class="sourceLineNo">391</span>     * List all messages.  A list attempt can only<a name="line.391"></a>
<span class="sourceLineNo">392</span>     * succeed if the client is in the<a name="line.392"></a>
<span class="sourceLineNo">393</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.393"></a>
<span class="sourceLineNo">394</span>     * .  Returns an array of POP3MessageInfo instances,<a name="line.394"></a>
<span class="sourceLineNo">395</span>     * each containing the number of a message and its size in bytes.<a name="line.395"></a>
<span class="sourceLineNo">396</span>     * If there are no messages, this method returns a zero length array.<a name="line.396"></a>
<span class="sourceLineNo">397</span>     * If the list attempt fails, it returns null.<a name="line.397"></a>
<span class="sourceLineNo">398</span>     * &lt;p&gt;<a name="line.398"></a>
<span class="sourceLineNo">399</span>     * @return An array of POP3MessageInfo instances representing all messages<a name="line.399"></a>
<span class="sourceLineNo">400</span>     * in the order they appear in the mailbox,<a name="line.400"></a>
<span class="sourceLineNo">401</span>     * each containing the number of a message and its size in bytes.<a name="line.401"></a>
<span class="sourceLineNo">402</span>     * If there are no messages, this method returns a zero length array.<a name="line.402"></a>
<span class="sourceLineNo">403</span>     * If the list attempt fails, it returns null.<a name="line.403"></a>
<span class="sourceLineNo">404</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.404"></a>
<span class="sourceLineNo">405</span>     *     sending the list command.<a name="line.405"></a>
<span class="sourceLineNo">406</span>     ***/<a name="line.406"></a>
<span class="sourceLineNo">407</span>    public POP3MessageInfo[] listMessages() throws IOException<a name="line.407"></a>
<span class="sourceLineNo">408</span>    {<a name="line.408"></a>
<span class="sourceLineNo">409</span>        if (getState() != TRANSACTION_STATE) {<a name="line.409"></a>
<span class="sourceLineNo">410</span>            return null;<a name="line.410"></a>
<span class="sourceLineNo">411</span>        }<a name="line.411"></a>
<span class="sourceLineNo">412</span>        if (sendCommand(POP3Command.LIST) != POP3Reply.OK) {<a name="line.412"></a>
<span class="sourceLineNo">413</span>            return null;<a name="line.413"></a>
<span class="sourceLineNo">414</span>        }<a name="line.414"></a>
<span class="sourceLineNo">415</span>        getAdditionalReply();<a name="line.415"></a>
<span class="sourceLineNo">416</span><a name="line.416"></a>
<span class="sourceLineNo">417</span>        // This could be a zero length array if no messages present<a name="line.417"></a>
<span class="sourceLineNo">418</span>        POP3MessageInfo[] messages = new POP3MessageInfo[_replyLines.size() - 2]; // skip first and last lines<a name="line.418"></a>
<span class="sourceLineNo">419</span><a name="line.419"></a>
<span class="sourceLineNo">420</span>        ListIterator&lt;String&gt; en = _replyLines.listIterator(1); // Skip first line<a name="line.420"></a>
<span class="sourceLineNo">421</span><a name="line.421"></a>
<span class="sourceLineNo">422</span>        // Fetch lines.<a name="line.422"></a>
<span class="sourceLineNo">423</span>        for (int line = 0; line &lt; messages.length; line++) {<a name="line.423"></a>
<span class="sourceLineNo">424</span>            messages[line] = __parseStatus(en.next());<a name="line.424"></a>
<span class="sourceLineNo">425</span>        }<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span>        return messages;<a name="line.427"></a>
<span class="sourceLineNo">428</span>    }<a name="line.428"></a>
<span class="sourceLineNo">429</span><a name="line.429"></a>
<span class="sourceLineNo">430</span>    /***<a name="line.430"></a>
<span class="sourceLineNo">431</span>     * List the unique identifier for a message.  A list attempt can only<a name="line.431"></a>
<span class="sourceLineNo">432</span>     * succeed if the client is in the<a name="line.432"></a>
<span class="sourceLineNo">433</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.433"></a>
<span class="sourceLineNo">434</span>     * .  Returns a POP3MessageInfo instance<a name="line.434"></a>
<span class="sourceLineNo">435</span>     * containing the number of the listed message and the<a name="line.435"></a>
<span class="sourceLineNo">436</span>     * unique identifier for that message.  Returns null if the list<a name="line.436"></a>
<span class="sourceLineNo">437</span>     * attempt fails  (e.g., if the specified message number does<a name="line.437"></a>
<span class="sourceLineNo">438</span>     * not exist).<a name="line.438"></a>
<span class="sourceLineNo">439</span>     * &lt;p&gt;<a name="line.439"></a>
<span class="sourceLineNo">440</span>     * @param messageId  The number of the message list.<a name="line.440"></a>
<span class="sourceLineNo">441</span>     * @return A POP3MessageInfo instance containing the number of the<a name="line.441"></a>
<span class="sourceLineNo">442</span>     *         listed message and the unique identifier for that message.<a name="line.442"></a>
<span class="sourceLineNo">443</span>     *         Returns null if the list attempt fails.<a name="line.443"></a>
<span class="sourceLineNo">444</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.444"></a>
<span class="sourceLineNo">445</span>     *        sending the list unique identifier command.<a name="line.445"></a>
<span class="sourceLineNo">446</span>     ***/<a name="line.446"></a>
<span class="sourceLineNo">447</span>    public POP3MessageInfo listUniqueIdentifier(int messageId)<a name="line.447"></a>
<span class="sourceLineNo">448</span>    throws IOException<a name="line.448"></a>
<span class="sourceLineNo">449</span>    {<a name="line.449"></a>
<span class="sourceLineNo">450</span>        if (getState() != TRANSACTION_STATE) {<a name="line.450"></a>
<span class="sourceLineNo">451</span>            return null;<a name="line.451"></a>
<span class="sourceLineNo">452</span>        }<a name="line.452"></a>
<span class="sourceLineNo">453</span>        if (sendCommand(POP3Command.UIDL, Integer.toString(messageId))<a name="line.453"></a>
<span class="sourceLineNo">454</span>                != POP3Reply.OK) {<a name="line.454"></a>
<span class="sourceLineNo">455</span>            return null;<a name="line.455"></a>
<span class="sourceLineNo">456</span>        }<a name="line.456"></a>
<span class="sourceLineNo">457</span>        return __parseUID(_lastReplyLine.substring(3));<a name="line.457"></a>
<span class="sourceLineNo">458</span>    }<a name="line.458"></a>
<span class="sourceLineNo">459</span><a name="line.459"></a>
<span class="sourceLineNo">460</span><a name="line.460"></a>
<span class="sourceLineNo">461</span>    /***<a name="line.461"></a>
<span class="sourceLineNo">462</span>     * List the unique identifiers for all messages.  A list attempt can only<a name="line.462"></a>
<span class="sourceLineNo">463</span>     * succeed if the client is in the<a name="line.463"></a>
<span class="sourceLineNo">464</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.464"></a>
<span class="sourceLineNo">465</span>     * .  Returns an array of POP3MessageInfo instances,<a name="line.465"></a>
<span class="sourceLineNo">466</span>     * each containing the number of a message and its unique identifier.<a name="line.466"></a>
<span class="sourceLineNo">467</span>     * If there are no messages, this method returns a zero length array.<a name="line.467"></a>
<span class="sourceLineNo">468</span>     * If the list attempt fails, it returns null.<a name="line.468"></a>
<span class="sourceLineNo">469</span>     * &lt;p&gt;<a name="line.469"></a>
<span class="sourceLineNo">470</span>     * @return An array of POP3MessageInfo instances representing all messages<a name="line.470"></a>
<span class="sourceLineNo">471</span>     * in the order they appear in the mailbox,<a name="line.471"></a>
<span class="sourceLineNo">472</span>     * each containing the number of a message and its unique identifier<a name="line.472"></a>
<span class="sourceLineNo">473</span>     * If there are no messages, this method returns a zero length array.<a name="line.473"></a>
<span class="sourceLineNo">474</span>     * If the list attempt fails, it returns null.<a name="line.474"></a>
<span class="sourceLineNo">475</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.475"></a>
<span class="sourceLineNo">476</span>     *     sending the list unique identifier command.<a name="line.476"></a>
<span class="sourceLineNo">477</span>     ***/<a name="line.477"></a>
<span class="sourceLineNo">478</span>    public POP3MessageInfo[] listUniqueIdentifiers() throws IOException<a name="line.478"></a>
<span class="sourceLineNo">479</span>    {<a name="line.479"></a>
<span class="sourceLineNo">480</span>        if (getState() != TRANSACTION_STATE) {<a name="line.480"></a>
<span class="sourceLineNo">481</span>            return null;<a name="line.481"></a>
<span class="sourceLineNo">482</span>        }<a name="line.482"></a>
<span class="sourceLineNo">483</span>        if (sendCommand(POP3Command.UIDL) != POP3Reply.OK) {<a name="line.483"></a>
<span class="sourceLineNo">484</span>            return null;<a name="line.484"></a>
<span class="sourceLineNo">485</span>        }<a name="line.485"></a>
<span class="sourceLineNo">486</span>        getAdditionalReply();<a name="line.486"></a>
<span class="sourceLineNo">487</span><a name="line.487"></a>
<span class="sourceLineNo">488</span>        // This could be a zero length array if no messages present<a name="line.488"></a>
<span class="sourceLineNo">489</span>        POP3MessageInfo[] messages = new POP3MessageInfo[_replyLines.size() - 2]; // skip first and last lines<a name="line.489"></a>
<span class="sourceLineNo">490</span><a name="line.490"></a>
<span class="sourceLineNo">491</span>        ListIterator&lt;String&gt; en = _replyLines.listIterator(1); // skip first line<a name="line.491"></a>
<span class="sourceLineNo">492</span><a name="line.492"></a>
<span class="sourceLineNo">493</span>        // Fetch lines.<a name="line.493"></a>
<span class="sourceLineNo">494</span>        for (int line = 0; line &lt; messages.length; line++) {<a name="line.494"></a>
<span class="sourceLineNo">495</span>            messages[line] = __parseUID(en.next());<a name="line.495"></a>
<span class="sourceLineNo">496</span>        }<a name="line.496"></a>
<span class="sourceLineNo">497</span><a name="line.497"></a>
<span class="sourceLineNo">498</span>        return messages;<a name="line.498"></a>
<span class="sourceLineNo">499</span>    }<a name="line.499"></a>
<span class="sourceLineNo">500</span><a name="line.500"></a>
<span class="sourceLineNo">501</span><a name="line.501"></a>
<span class="sourceLineNo">502</span>    /**<a name="line.502"></a>
<span class="sourceLineNo">503</span>     * Retrieve a message from the POP3 server.  A retrieve message attempt<a name="line.503"></a>
<span class="sourceLineNo">504</span>     * can only succeed if the client is in the<a name="line.504"></a>
<span class="sourceLineNo">505</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.505"></a>
<span class="sourceLineNo">506</span>     * &lt;p&gt;<a name="line.506"></a>
<span class="sourceLineNo">507</span>     * You must not issue any commands to the POP3 server (i.e., call any<a name="line.507"></a>
<span class="sourceLineNo">508</span>     * other methods) until you finish reading the message from the<a name="line.508"></a>
<span class="sourceLineNo">509</span>     * returned BufferedReader instance.<a name="line.509"></a>
<span class="sourceLineNo">510</span>     * The POP3 protocol uses the same stream for issuing commands as it does<a name="line.510"></a>
<span class="sourceLineNo">511</span>     * for returning results.  Therefore the returned BufferedReader actually reads<a name="line.511"></a>
<span class="sourceLineNo">512</span>     * directly from the POP3 connection.  After the end of message has been<a name="line.512"></a>
<span class="sourceLineNo">513</span>     * reached, new commands can be executed and their replies read.  If<a name="line.513"></a>
<span class="sourceLineNo">514</span>     * you do not follow these requirements, your program will not work<a name="line.514"></a>
<span class="sourceLineNo">515</span>     * properly.<a name="line.515"></a>
<span class="sourceLineNo">516</span>     * &lt;p&gt;<a name="line.516"></a>
<span class="sourceLineNo">517</span>     * @param messageId  The number of the message to fetch.<a name="line.517"></a>
<span class="sourceLineNo">518</span>     * @return A DotTerminatedMessageReader instance<a name="line.518"></a>
<span class="sourceLineNo">519</span>     * from which the entire message can be read.<a name="line.519"></a>
<span class="sourceLineNo">520</span>     * This can safely be cast to a {@link java.io.BufferedReader BufferedReader} in order to<a name="line.520"></a>
<span class="sourceLineNo">521</span>     * use the {@link java.io.BufferedReader#readLine() BufferedReader#readLine()} method.<a name="line.521"></a>
<span class="sourceLineNo">522</span>     * Returns null if the retrieval attempt fails  (e.g., if the specified<a name="line.522"></a>
<span class="sourceLineNo">523</span>     * message number does not exist).<a name="line.523"></a>
<span class="sourceLineNo">524</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.524"></a>
<span class="sourceLineNo">525</span>     *        sending the retrieve message command.<a name="line.525"></a>
<span class="sourceLineNo">526</span>     */<a name="line.526"></a>
<span class="sourceLineNo">527</span>    public Reader retrieveMessage(int messageId) throws IOException<a name="line.527"></a>
<span class="sourceLineNo">528</span>    {<a name="line.528"></a>
<span class="sourceLineNo">529</span>        if (getState() != TRANSACTION_STATE) {<a name="line.529"></a>
<span class="sourceLineNo">530</span>            return null;<a name="line.530"></a>
<span class="sourceLineNo">531</span>        }<a name="line.531"></a>
<span class="sourceLineNo">532</span>        if (sendCommand(POP3Command.RETR, Integer.toString(messageId)) != POP3Reply.OK) {<a name="line.532"></a>
<span class="sourceLineNo">533</span>            return null;<a name="line.533"></a>
<span class="sourceLineNo">534</span>        }<a name="line.534"></a>
<span class="sourceLineNo">535</span><a name="line.535"></a>
<span class="sourceLineNo">536</span>        return new DotTerminatedMessageReader(_reader);<a name="line.536"></a>
<span class="sourceLineNo">537</span>    }<a name="line.537"></a>
<span class="sourceLineNo">538</span><a name="line.538"></a>
<span class="sourceLineNo">539</span><a name="line.539"></a>
<span class="sourceLineNo">540</span>    /**<a name="line.540"></a>
<span class="sourceLineNo">541</span>     * Retrieve only the specified top number of lines of a message from the<a name="line.541"></a>
<span class="sourceLineNo">542</span>     * POP3 server.  A retrieve top lines attempt<a name="line.542"></a>
<span class="sourceLineNo">543</span>     * can only succeed if the client is in the<a name="line.543"></a>
<span class="sourceLineNo">544</span>     * {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }<a name="line.544"></a>
<span class="sourceLineNo">545</span>     * &lt;p&gt;<a name="line.545"></a>
<span class="sourceLineNo">546</span>     * You must not issue any commands to the POP3 server (i.e., call any<a name="line.546"></a>
<span class="sourceLineNo">547</span>     * other methods) until you finish reading the message from the returned<a name="line.547"></a>
<span class="sourceLineNo">548</span>     * BufferedReader instance.<a name="line.548"></a>
<span class="sourceLineNo">549</span>     * The POP3 protocol uses the same stream for issuing commands as it does<a name="line.549"></a>
<span class="sourceLineNo">550</span>     * for returning results.  Therefore the returned BufferedReader actually reads<a name="line.550"></a>
<span class="sourceLineNo">551</span>     * directly from the POP3 connection.  After the end of message has been<a name="line.551"></a>
<span class="sourceLineNo">552</span>     * reached, new commands can be executed and their replies read.  If<a name="line.552"></a>
<span class="sourceLineNo">553</span>     * you do not follow these requirements, your program will not work<a name="line.553"></a>
<span class="sourceLineNo">554</span>     * properly.<a name="line.554"></a>
<span class="sourceLineNo">555</span>     * &lt;p&gt;<a name="line.555"></a>
<span class="sourceLineNo">556</span>     * @param messageId  The number of the message to fetch.<a name="line.556"></a>
<span class="sourceLineNo">557</span>     * @param numLines  The top number of lines to fetch. This must be &gt;= 0.<a name="line.557"></a>
<span class="sourceLineNo">558</span>     * @return  A DotTerminatedMessageReader instance<a name="line.558"></a>
<span class="sourceLineNo">559</span>     * from which the specified top number of lines of the message can be<a name="line.559"></a>
<span class="sourceLineNo">560</span>     * read.<a name="line.560"></a>
<span class="sourceLineNo">561</span>     * This can safely be cast to a {@link java.io.BufferedReader BufferedReader} in order to<a name="line.561"></a>
<span class="sourceLineNo">562</span>     * use the {@link java.io.BufferedReader#readLine() BufferedReader#readLine()} method.<a name="line.562"></a>
<span class="sourceLineNo">563</span>     * Returns null if the retrieval attempt fails  (e.g., if the specified<a name="line.563"></a>
<span class="sourceLineNo">564</span>     * message number does not exist).<a name="line.564"></a>
<span class="sourceLineNo">565</span>     * @exception IOException If a network I/O error occurs in the process of<a name="line.565"></a>
<span class="sourceLineNo">566</span>     *       sending the top command.<a name="line.566"></a>
<span class="sourceLineNo">567</span>     */<a name="line.567"></a>
<span class="sourceLineNo">568</span>    public Reader retrieveMessageTop(int messageId, int numLines)<a name="line.568"></a>
<span class="sourceLineNo">569</span>    throws IOException<a name="line.569"></a>
<span class="sourceLineNo">570</span>    {<a name="line.570"></a>
<span class="sourceLineNo">571</span>        if (numLines &lt; 0 || getState() != TRANSACTION_STATE) {<a name="line.571"></a>
<span class="sourceLineNo">572</span>            return null;<a name="line.572"></a>
<span class="sourceLineNo">573</span>        }<a name="line.573"></a>
<span class="sourceLineNo">574</span>        if (sendCommand(POP3Command.TOP, Integer.toString(messageId) + " " +<a name="line.574"></a>
<span class="sourceLineNo">575</span>                        Integer.toString(numLines)) != POP3Reply.OK) {<a name="line.575"></a>
<span class="sourceLineNo">576</span>            return null;<a name="line.576"></a>
<span class="sourceLineNo">577</span>        }<a name="line.577"></a>
<span class="sourceLineNo">578</span><a name="line.578"></a>
<span class="sourceLineNo">579</span>        return new DotTerminatedMessageReader(_reader);<a name="line.579"></a>
<span class="sourceLineNo">580</span>    }<a name="line.580"></a>
<span class="sourceLineNo">581</span><a name="line.581"></a>
<span class="sourceLineNo">582</span><a name="line.582"></a>
<span class="sourceLineNo">583</span>}<a name="line.583"></a>
<span class="sourceLineNo">584</span><a name="line.584"></a>




























































</pre>
</div>
</body>
</html>
